<!DOCTYPE html
  PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
  "DTD/xhtml1-strict.dtd">
<html>
  <head>
    <title>volatility.obj : API documentation</title>
    <meta content="text/html;charset=utf-8" http-equiv="Content-Type" />
    <link href="apidocs.css" type="text/css" rel="stylesheet" />
    
    
  </head>
  <body>
    <h1 class="module">v.obj : module documentation</h1>
    <p>
      <span id="part">Part of <a href="volatility.html">volatility</a></span>
      
      
    </p>
    <div>
      
    </div>
    <div>&#64;author:       AAron Walters
&#64;license:      GNU General Public License 2.0 or later
&#64;contact:      <a class="rst-reference external" href="mailto:awalters&#64;volatilesystems.com" target="_top">awalters&#64;volatilesystems.com</a>
&#64;organization: Volatile Systems<table class="fieldTable"></table></div>

    
    
    <div id="splitTables">
      <table class="children sortable" id="id1404">
  
  
<tr class="class">
    
    
    <td>Class</td>
    <td><a href="volatility.obj.classproperty.html">classproperty</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="function">
    
    
    <td>Function</td>
    <td><a href="volatility.obj.html#get_bt_string">get_bt_string</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="class">
    
    
    <td>Class</td>
    <td><a href="volatility.obj.NoneObject.html">NoneObject</a></td>
    <td><span>A magical object which is like None but swallows bad dereferences, __getattribute__, iterators etc to return itself.</span></td>
  </tr><tr class="class">
    
    
    <td>Class</td>
    <td><a href="volatility.obj.InvalidOffsetError.html">InvalidOffsetError</a></td>
    <td><span>Simple placeholder to identify invalid offsets</span></td>
  </tr><tr class="function">
    
    
    <td>Function</td>
    <td><a href="volatility.obj.html#Object">Object</a></td>
    <td><span>A function which instantiates the object named in theType (as a string) from the type in profile passing optional args of kwargs.</span></td>
  </tr><tr class="class">
    
    
    <td>Class</td>
    <td><a href="volatility.obj.BaseObject.html">BaseObject</a></td>
    <td><span class="undocumented">No class docstring; 8/30 methods documented</span></td>
  </tr><tr class="function">
    
    
    <td>Function</td>
    <td><a href="volatility.obj.html#CreateMixIn">CreateMixIn</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="class">
    
    
    <td>Class</td>
    <td><a href="volatility.obj.NumericProxyMixIn.html">NumericProxyMixIn</a></td>
    <td><span>This MixIn implements the numeric protocol</span></td>
  </tr><tr class="class">
    
    
    <td>Class</td>
    <td><a href="volatility.obj.NativeType.html">NativeType</a></td>
    <td><span class="undocumented">No class docstring; 1/8 methods documented</span></td>
  </tr><tr class="class">
    
    
    <td>Class</td>
    <td><a href="volatility.obj.BitField.html">BitField</a></td>
    <td><span>A class splitting an integer into a bunch of bit.</span></td>
  </tr><tr class="class">
    
    
    <td>Class</td>
    <td><a href="volatility.obj.Pointer.html">Pointer</a></td>
    <td><span class="undocumented">No class docstring; 1/13 methods documented</span></td>
  </tr><tr class="class">
    
    
    <td>Class</td>
    <td><a href="volatility.obj.Void.html">Void</a></td>
    <td><span class="undocumented">Undocumented</span></td>
  </tr><tr class="class">
    
    
    <td>Class</td>
    <td><a href="volatility.obj.Array.html">Array</a></td>
    <td><span>An array of objects of the same size</span></td>
  </tr><tr class="class">
    
    
    <td>Class</td>
    <td><a href="volatility.obj.CType.html">CType</a></td>
    <td><span>A CType is an object which represents a c struct</span></td>
  </tr><tr class="class">
    
    
    <td>Class</td>
    <td><a href="volatility.obj.VolatilityMagic.html">VolatilityMagic</a></td>
    <td><span>Class to contain Volatility Magic value</span></td>
  </tr><tr class="function">
    
    
    <td>Function</td>
    <td><a href="volatility.obj.html#VolMagic">VolMagic</a></td>
    <td><span>Convenience function to save people typing out an actual obj.Object call</span></td>
  </tr><tr class="class">
    
    
    <td>Class</td>
    <td><a href="volatility.obj.Profile.html">Profile</a></td>
    <td><span class="undocumented">No class docstring; 1/1 class methods, 18/20 methods documented</span></td>
  </tr><tr class="class">
    
    
    <td>Class</td>
    <td><a href="volatility.obj.ProfileModification.html">ProfileModification</a></td>
    <td><span>Class for modifying profiles for additional functionality</span></td>
  </tr>
  
</table>
      
      
    </div>
    
    
    

    <div class="function">
  <a name="volatility.obj.get_bt_string">
    
  </a>
  <a name="get_bt_string">
    
  </a>
  <div class="functionHeader">
    
    def
    get_bt_string(_e=None):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.obj.Object">
    
  </a>
  <a name="Object">
    
  </a>
  <div class="functionHeader">
    
    def
    Object(theType, offset, vm, name=None, **kwargs):
    
  </div>
  <div class="functionBody">
    
    <div>A function which instantiates the object named in theType (as
a string) from the type in profile passing optional args of
kwargs.<table class="fieldTable"></table></div>
  </div>
</div><div class="function">
  <a name="volatility.obj.CreateMixIn">
    
  </a>
  <a name="CreateMixIn">
    
  </a>
  <div class="functionHeader">
    
    def
    CreateMixIn(mixin):
    
  </div>
  <div class="functionBody">
    
    <div class="undocumented">Undocumented</div>
  </div>
</div><div class="function">
  <a name="volatility.obj.VolMagic">
    
  </a>
  <a name="VolMagic">
    
  </a>
  <div class="functionHeader">
    
    def
    VolMagic(vm):
    
  </div>
  <div class="functionBody">
    
    <div>Convenience function to save people typing out an actual obj.Object call<table class="fieldTable"></table></div>
  </div>
</div>
    <address>
      <a href="index.html">API Documentation</a> for Volatility 2.2, generated by <a href="http://codespeak.net/~mwh/pydoctor/">pydoctor</a> at 2013-06-24 15:16:10.
    </address>
  </body>
</html>